AdBookConnect Web Service
Appendix C: Read-Only Properties

Version 28 of the AdBook+ API introduced a read-only properties collection on the Drop object.

 

Field Name Field Label Description
Agency_Commission_Amount Agency Commission Amount Agency commission amount based on Drop cost and Agency Commission %
Breakout_Details Split Details Name used to traffic splits (breakouts) for Methode ad server
Competitive_Exclusion_Name Competitive Exclusion Name Friendly name for Competitive Exclusion value selected on the Drop
DFP_Line_Item_Status DFP Line Item Status Current Line Item Status for the Drop in GAM360
Drop_Third_Party_Ad_Server_Buffered_Impression 3rd Party Ad Server Buffered Impressions Total number of buffered impressions for the Drop based on Drop 3rd Party Impressions and 3rd Party Buffer %
First_Party_Delivered_Impressions 1st Party Delivered Impressions Impressions delivered FTD for the Drop by the publisher's ad server
Geo_Targeting_Ids Geography IDs Comma delimited list of IDs for selected Geography targets
Line_Item_Gross_Cost Gross Line Item Cost Drop Gross Cost based on Drop Cost and Agency Commission Amount
Line_Item_Gross_Price Gross Line Item Price Drop Gross Price based on Drop Price and Agency Commission Amount
Package_Component_Original_Allocation Original Allocation % Original Allocation % for an auto allocated package component
Package_ID Package ID Package ID for a package component drop
Technology_Targeting_Ids Technology IDs Comma delimited list of IDs for selected Technology targets
Third_Party_Delivered_Impressions 3rd Party Delivered Impressions Impressions Delivered FTD for the Drop by the 3rd party ad server
Traffic_Status Traffic Status Current traffic status for the Drop
Video_Content_Targeting_Ids Video Content IDs Comma delimited list of IDs for selected Video Content targets

 


 Version 32 of the AdBook+ API introduced a read-only properties collection on the Order object.

 

Field Name Field Label Description
Ad_Server_Order_ID Ad Server Order ID(s) The order IDs corresponding to the campaign in the ad server.
Agency_Commission_Amount Agency Commission Amount The amount applied as an Agency Discount to the Gross Cost of the campaign.
Campaign_Creative_Status Campaign Creative Status The calculated creative status for the campaign based on line item creative statuses.
Deal_Quality_Score Deal Quality Score Calculated field to measure health of pricing on a campaign relative to rate card.
Campaign_Total_Gross_Cost Gross Total Cost The total gross cost of the campaign.
Master_Campaign_ID Master Campaign The master campaign in a co-op.
Participant_Campaign_IDs Participant Campaigns The participant campaigns in a co-op.
Proposal_Negotiation_Status Proposal Negotiation Status The status of the Programmatic Proposal imported from GAM.
Remaining_Budget Remaining Budget Output field for campaign level Remaining Budget. Remaining Budget is Total Budget less Total Net Cost of the campaign.
Revision_PDF_URL Revision PDF URL A link to the revision PDF for the campaign.
Campaign_Total_Cost Total Net Cost The total net cost of the campaign.
Value_Add_% Value Add % The percentage of value add line items on a campaign.
WO_Export_Status WideOrbit Export Status The export status of the campaign to WideOrbit.

 


 Version 36 of the AdBook+ API introduced a read-only properties collection on the Agency, AgencyContact, Client and ClientContact objects.

 

Field Name Field Label Description
DefaultAddressId N/A The ID of the default address associated with the entity.